CreateOwnerIterator

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODFocusModule

CreateOwnerIterator
The CreateOwnerIterator method should create a focus-owner iterator to give callers access to the frames that own the specified nonexclusive focus.
ODFocusOwnerIterator CreateOwnerIterator (
                                    in ODTypeToken focus);
focus
A tokenized string representing the focus type whose frames you want to enumerate, expressed as a 32-bit value.
return value
A reference to a new focus-owner iterator object, or kODNULL if the focus is exclusive.

DISCUSSION
The focus parameter must be the tokenized form of one of the focus constants (kODClipboardFocus, kODKeyFocus, kODMenuFocus, kODModalFocus, kODMouseFocus, kODScrollingFocus, or kODSelectionFocus) or the tokenized form of a part-specific focus type. You can call the session object's Tokenize method to obtain a token corresponding to one of these constants.
OpenDoc calls this method. This method should create and initialize an instance of a focus-owner iterator that can iterate over this focus module's focus owners, and return the iterator to the caller.
While you are using a focus-owner iterator, you should not modify the list of focus owners. You must postpone adding items to or removing items from the list of focus owners until after you have deleted the iterator.

OVERRIDING
If you subclass ODFocusModule, you must override this method. Your override method must not call its inherited method; that is, your override method must implement this method's functionality completely.

SEE ALSO
The ODFocusType type (page 889).
The ODTypeToken type (page 877).
The ODSession::Tokenize method (page 622).
The ODFocusOwnerIterator class (page 278).